Skip to content

feat(rtsp): Add readme for python code and add requirements file and mdns script for ease of use#483

Merged
finger563 merged 2 commits intomainfrom
feat/python-rtsp-mdns-client.py
Aug 8, 2025
Merged

feat(rtsp): Add readme for python code and add requirements file and mdns script for ease of use#483
finger563 merged 2 commits intomainfrom
feat/python-rtsp-mdns-client.py

Conversation

@finger563
Copy link
Copy Markdown
Contributor

Description

  • Add mDNS variant of the rtsp_client.py example script to make testing
    easier, esp. with the
    esp-cpp/camera-streamer project.
  • Add requirements.txt file for easier dependency management
  • Add README.md which explains how to use the scripts in the rtsp/python
    folder.
  • Update the rtsp/readme to point to the python directory for easier discoveryability.

Motivation and Context

Allows others to better find and use these tools.

How has this been tested?

Running the scripts and ensuring they work based on the instructions.

Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update
  • Hardware (schematic, board, system design) change
  • Software change

Checklist:

  • My change requires a change to the documentation.
  • I have added / updated the documentation related to this change via either README or WIKI

Software

  • I have added tests to cover my changes.
  • I have updated the .github/workflows/build.yml file to add my new test to the automated cloud build github action.
  • All new and existing tests passed.
  • My code follows the code style of this project.

@finger563 finger563 self-assigned this Aug 8, 2025
@finger563 finger563 requested a review from Copilot August 8, 2025 14:48
@finger563 finger563 added enhancement New feature or request rtsp python labels Aug 8, 2025
@finger563 finger563 merged commit 10e1bbd into main Aug 8, 2025
88 of 90 checks passed
@finger563 finger563 deleted the feat/python-rtsp-mdns-client.py branch August 8, 2025 14:48
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR enhances the RTSP component's Python testing utilities by adding mDNS service discovery capabilities, dependency management, and comprehensive documentation. It improves the developer experience for testing RTSP server implementations, particularly with the esp-cpp/camera-streamer project.

  • Adds mDNS-enabled RTSP client for automatic service discovery
  • Creates requirements.txt for Python dependency management
  • Provides detailed README documentation for the Python scripts
  • Updates main RTSP README to reference Python utilities

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
components/rtsp/python/rtsp_client_mdns.py New RTSP client with mDNS discovery for automatic server detection
components/rtsp/python/requirements.txt Python dependencies file for easy setup
components/rtsp/python/README.md Comprehensive documentation for Python RTSP utilities
components/rtsp/README.md Updated to reference Python testing utilities

Comment thread components/rtsp/python/rtsp_client_mdns.py
Comment thread components/rtsp/python/rtsp_client_mdns.py
Comment thread components/rtsp/python/rtsp_client_mdns.py
Comment thread components/rtsp/python/rtsp_client_mdns.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request python rtsp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants